home *** CD-ROM | disk | FTP | other *** search
/ Info-Mac 3 / Info_Mac_1994-01.iso / Compression / Binary Pump / Documentation < prev    next >
Encoding:
Text File  |  1993-12-04  |  8.7 KB  |  225 lines  |  [TEXT/EDIT]
  1. Binary Pump 1.0
  2. ---------------
  3.  
  4.  
  5. Binary pump is a simple utility which attempts to recognize files by their
  6. contents, and sets their file types and creators correctly.
  7.  
  8. When are the file types and creators NOT correct? Well, when you transfer
  9. files between Macintosh's, you usually use something called MacBinary. 
  10. This allows Mac's to correctly transfer things like creation date and file
  11. type and creator appropriately. But when you transfer from IBM PCs, Unix,
  12. or VAX systems, which don't use MacBinary, you will usually get a generic
  13. file type and creator. Thus, you won't be able to do normal mac things to
  14. these files, such as open them by double-clicking (you'll get the "The 
  15. Appleication that created this file cannot by found", or you'll end up
  16. running your communications program!)
  17.  
  18. One exception to this rule (maybe more than one...) is the program Zterm.
  19. I think since version .85, it has been able to correctly recognize files
  20. transfered from foreign (non-macbinary) systems. To its credit, much of
  21. Binary Pump has been modeled around Zterm's implementation of this 
  22. feature. But Zterm falls a little short in some areas, the main one being
  23. customizability.  
  24.  
  25. In order to customize Zterm's file recognition, you have
  26. to open up Zterm with resedit, create a new string, and then enter
  27. the file recognition information in the correct format. This is pretty
  28. crude to say the least. Fortunately for Zterm users, its author
  29. stuck in plenty of file types to satisfy most users.
  30.  
  31. In addition, many other (commercial or shareware) programs, do not support
  32. this feature, which I have found to be very convenient.
  33.  
  34. By the way, this program is NOT a macbinary filter.  If you download a file
  35. which was uploaded in Macbinary format using binary (instead of Macbinary),
  36. this program will NOT normally interpret that Macbinary info. There
  37. are some programs like stuffit deluxe which can do this. Maybe i'll add this
  38. in the future.  If you think you'd really like this feature, write me and
  39. i'll put it in.
  40.  
  41. Usage
  42. -----
  43.  
  44. There's really not much to explain here. To convert your files, simply drag
  45. and drop them onto Binary Pump.
  46.  
  47. Binary Pump was made to be very unobstrusive, thus it doesn't give much of
  48. a response.  Currently, all it does is flash a watch on the screen _very_
  49. quickly.  If no tag was found for a file an exclamation mark will flash
  50. _very_ quickly.  I did this on purpose since I hate it when Dialogs,sounds,
  51. or otherwise pop up on the screen, slowing the process down.  If you want
  52. some sort of report at the end of file conversion, ask me and i'll stick
  53. it in as some sort of option.
  54.  
  55. If you don't have System 7.0, these methods will work:
  56.  
  57. An alternative method is to launch Binary Pump (by double-clicking) and then
  58. openning each file to convert from the File menu.
  59.  
  60. Yet another alternative method is to get into your comm program's
  61. transfer settings area.  Set the Creator Type of Binary files to BINP
  62. Now, whenever you have a binary file that's been transfered without
  63. macbinary, you can double click on it (or a group of files), and have
  64. Binary Pump automatically convert them.
  65. If you use Microphone II, this setting should be in the Settings->Protocal
  66. Transfer dialog box, in the top part of the window, in the area with the
  67. 'Auto Detect' checkbox.
  68.  
  69. If you indirectly run Binary Pump, (i.e. through drag and drop or double-
  70. clickin on files, other than the Binary Pump application), Binary Pump 
  71. will automatically quit after converting the requested files.
  72.  
  73. Note: After converting files, the Finder is slow to recognize that the file
  74. types have changed. Thus, immediately after conversion, the file's icon will
  75. still be incorrect and the files still won't be double-clickable.
  76. To update the finder, close and re-open the folder in which the files 
  77. (that were converted) reside.
  78.  
  79. AppleEvents
  80.  
  81. In System 7.0 and later, it should be possible to send an ODOC appleevent
  82. to Binary pump, with a descriptor list of files to convert. In this case,
  83. Binary Pump must already be running.
  84.  
  85. Or, you can send an apple event to the finder, and have it launch Binary
  86. Pump and open thedesired files.  Binary Pump will automatically quit when
  87. the files have been converted.
  88.  
  89. Customization
  90. -------------
  91.  
  92. This is Binary Pump's strong suite.  Customization is fairly simple.
  93.  
  94. To Add a new entry to Binary Pump:
  95.  
  96. 1. Choose Edit Table… from the File Menu.
  97.    A window containing a list of entries will appear.
  98.  
  99. 2. Enter a binary tag or a file name extension in the area labeled "Tag"
  100.    File name extensions _must_ have a leading period. e.g., .jpg or .gif
  101.    The maximum length for a tag or extension is 39 characters.
  102.    The tag must also be unique -- it can't already exist in the entry
  103.    list.  See replacing entries down below for more info.
  104.    Also, tag's are case sensitive!!
  105.    
  106. 3. Enter a File Type  and Creator in the corresponding areas.
  107.    File Types and Creators _must_ be 4 characters.  Binary Pump will
  108.    not accept anything else.
  109.    File Types and Creators are also case sensitive!
  110.    
  111. 4. Click on the New button.
  112.    A new entry will be created in the entry list.
  113.    If Binary Pump beeps, see if you met the requirements in steps 2 and 3.
  114.    If the tag has any non-displayable characters, it will be displayed
  115.    as <*> in the entry list.
  116.    
  117.    
  118. Normally, binary tags aren't very easy to obtain. Some files have simple ones
  119. like 'GIF8' for gif files. Others have weird and unrecognizable ones.  Thus,
  120. binary pump offers two ways to extract these tags from files.
  121.  
  122. "Scan 4 char" will simply take the first 4 characters of a file and use it as a
  123. tag.
  124.  
  125. Unfortunately, not all files (and in fact, fairly few) use 4 character tags at
  126. the beginning of their files.
  127.  
  128. "Scan 2 file" will ask you to find two files (the fiel dialog will appear
  129. twice!).
  130. It is imperative that you _not_ choose the same file both times!!!! Scan 2 File
  131. takes two different files of the same type, and finds the similarities. The
  132. philosophy behind this is that if the PCX file a and the PCX file b have x 
  133. letters in common, any future files which share these x letters will be a PCX
  134. file also.  Although this method is better than "Scan 4 char", it's still not
  135. fullproof.  Some programs store signatures/similarities at offsets from the
  136. beggining of othe file.  In this case, using a file name extension (e.g., .jpg)
  137. is your only choice.
  138.  
  139. In addition to binary tags, you have to supply file type and creator information.
  140. Although this information is generally easier to obtain, it can be nonetheless
  141. a pain in the butt.  Therefore, the button "Creator & Type" get's it for you!
  142. Just click on it and choose the file whose creator and type you want to obtain.
  143.  
  144. To Replace or change an entry in Binary Pump:
  145.  
  146. 1. Click on the entry to replace.
  147.  
  148. 2. Alter the entry -- change the tag, owner, or type.
  149.  
  150. 3. Click on the Replace button.
  151.  
  152.  
  153.  
  154. To Delete an entry:
  155.  
  156. 1. Click on the entry to delete.
  157.  
  158. 2. Click on the Delete button.
  159.  
  160. More Advanced Stuff
  161. -------------------
  162.  
  163. Replacing
  164.  
  165. Normally, when you click on an entry in a list, Binary Pump will update the
  166. tag, creator, and type fields.  This can be inconveniencing if you want
  167. to replace an entry which is not currently selected.  Thus, if you hold the
  168. option key and click on an entry, Binary Pump will _not_ update the fields.
  169. Be a little careful when using this since this allows you to create duplicate
  170. entries (entries with identical tags). This is not damaging to Binary Pump,
  171. but can make things confusing.
  172.  
  173.  
  174. Precedence
  175.  
  176. What if Binary Pump comes across a file that has _both_ a binary tag entry and
  177. a file name extension entry? Simply put, binary tags have precedence.
  178.  
  179. In addition, if you ever _do_ create duplicate entries (this is normally not
  180. possible), Binary Pump will use the first one entered.
  181.  
  182. Memory
  183.  
  184. Binary Pump takes up very little memory.  I've set the memory limit at 64k right
  185. now, but if you're really tight on memory, it can probably go to as low as 25-30k
  186.  
  187.  
  188. Liability and Stuff
  189. -------------------
  190.  
  191. Here we go again with liabily stuff and such. Simply put, use this software
  192. at your own risk!
  193.  
  194.  
  195. Public Domain
  196. -------------
  197.  
  198. This software may be used free of charge.
  199.  
  200. Feel free to distribute this software to any BBS's and such provided that
  201. you distribute _only_ the original files and _all_ of the files
  202. that were in the archive.
  203. The only exception is commercial distribution.  If you want to commercially 
  204. distribute this software, ask me.
  205.  
  206.  
  207.  
  208. Source Code
  209. -----------
  210.  
  211. Source code is available.  If you want it, ask me.  No guarentees about
  212. readability though.  I will try to go through the code and clean it up
  213. some (if only so I will be able to read it better!), but this software was
  214. pieced together in about 11 hours of time in which lotsa ugly code crept
  215. in.
  216.  
  217.  
  218. How to Reach Me
  219. ---------------
  220.  
  221. Internet: eshieh@soda.berkeley.edu
  222. Compuserve: 76164,765
  223. Regular Mail: Eric Shieh, P.O. Box 1235, Danville, CA 94526, USA
  224.  
  225.